gridpack::component::BaseBusComponent Class Reference

#include <base_component.hpp>

Inheritance diagram for gridpack::component::BaseBusComponent:

[legend]

Collaboration diagram for gridpack::component::BaseBusComponent:

[legend]

List of all members.

Public Member Functions
	BaseBusComponent (void)
virtual	~BaseBusComponent (void)
void	addBranch (const boost::shared_ptr< BaseComponent > &branch)
void	addBus (const boost::shared_ptr< BaseComponent > &bus)
void	getNeighborBranches (std::vector< boost::shared_ptr< BaseComponent > > &nghbrs) const
void	getNeighborBuses (std::vector< boost::shared_ptr< BaseComponent > > &nghbrs) const
void	clearBranches (void)
void	clearBuses (void)
void	setReferenceBus (bool status)
bool	getReferenceBus (void) const
void	setOriginalIndex (int idx)
int	getOriginalIndex (void) const
void	setGlobalIndex (int idx)
int	getGlobalIndex (void) const

---

Constructor & Destructor Documentation

gridpack::component::BaseBusComponent::BaseBusComponent

(

void

)

Simple constructor

virtual gridpack::component::BaseBusComponent::~BaseBusComponent

(

void

)

[virtual]

Simple destructor

---

Member Function Documentation

void gridpack::component::BaseBusComponent::addBranch

(

const boost::shared_ptr< BaseComponent > &

branch

)

Add a pointer to the list of branches that a bus is connected to

Parameters:

branch

pointer to a branch that is connected to bus

void gridpack::component::BaseBusComponent::addBus

(

const boost::shared_ptr< BaseComponent > &

bus

)

Add a pointer to the list of buses that a bus is connected to via a branch

Parameters:

bus

pointer to a bus that is connected to bus via a branch

void gridpack::component::BaseBusComponent::clearBranches

(

void

)

Clear all pointers to neighboring branches

void gridpack::component::BaseBusComponent::clearBuses

(

void

)

Clear all pointers to neighboring buses

int gridpack::component::BaseBusComponent::getGlobalIndex

(

void

)

const

Get global index

Returns:

global index from network

void gridpack::component::BaseBusComponent::getNeighborBranches

(

std::vector< boost::shared_ptr< BaseComponent > > &

nghbrs

)

const

Get pointers to branches that are connected to bus

Parameters:

nghbrs

list of pointers to neighboring branches

void gridpack::component::BaseBusComponent::getNeighborBuses

(

std::vector< boost::shared_ptr< BaseComponent > > &

nghbrs

)

const

Get pointers to buses that are connected to calling bus via a branch

Parameters:

nghbrs

list of pointers to neighboring buses

int gridpack::component::BaseBusComponent::getOriginalIndex

(

void

)

const

Get original index

Returns:

original index from network

bool gridpack::component::BaseBusComponent::getReferenceBus

(

void

)

const

Get reference bus status

Returns:

true if bus is reference bus, false otherwise

void gridpack::component::BaseBusComponent::setGlobalIndex

(

int

idx

)

Set global index

Parameters:

idx

global index from network

void gridpack::component::BaseBusComponent::setOriginalIndex

(

int

idx

)

Set original index (from input file)

Parameters:

idx

original index from network

void gridpack::component::BaseBusComponent::setReferenceBus

(

bool

status

)

Set reference bus status

Parameters:

status

reference bus status

---

The documentation for this class was generated from the following file:

• base_component.hpp